Auditing in CygNet Measurement
Auditing in the CygNet Measurement system is handled in two places.
- Internally via auditing in the FMS. All internal auditing involves actions related to device data.
- Externally via the standard CygNet Audit service (AUD) accessed through CygNet Explorer. All external auditing is related to system configuration changes.
Internal Auditing
Any significant actions surrounding device data triggered by a user will be audited internally by the FMS. The auditing criteria for these events is that they must be significant in terms of how they affect device data, and they must be singular events that cannot change over time. Auditing performed by the FMS is always enabled and does not have different levels of detail.
All internal audit records have an associated category type to help you understand what is happening in your system. The types of audits are described in the following table.
| Audit Type | Where Set |
|---|---|
|
System Configuration Change |
Configuring Node properties. Configuring Validation rules and Estimation rules |
|
Data Change |
Changing data on the History Grid control, Configuration, or Alarm controls |
|
Handling PPAs |
Approving PPA or rejecting PPA for export on the Prior Period Adjustment control |
|
Ignoring Exceptions |
Ignoring Exceptions on the Exceptions control. |
|
System Event |
Closing a period via the Close Period control or user command. |
The FMS audit categories per type of audit are configurable on the Admin menu. See Configuring Audit Categories for more information.
There are also cases where audit records are created internally and don’t require any user interaction. In these cases, there is no assigned audit category. The following is a list of instances where audit records will have no assigned category.
- Device data returned from polling engine
- Device data imported from an external source
- Validated data imported from an external source
- Estimation Engine auto-estimated gas metering/gas quality records
- System created Configuration Log record due to events or frozen constant flow parameter
External Auditing
All auditing of actions related to configuration changes is handled by the CygNet Audit service (AUD). Auditing by the Audit service is optional. Each FMS has a set of configuration file keywords, that determine the record types that can be audited and the level of auditing. For an audited record type, any adds, deletes or updates to that record type will be audited.
The Audit history button is provided as part of the Historization Navigator for any FMS record that has an audit trail. See Viewing Audit History for more information.
In addition, there are four possible reporting modes. The reporting mode determines how the corresponding audit records are referenced in the Audit service.
- Node ID (Auditing mode NODE_ID)
- Reporting Facility ID (Auditing mode REPORTING_FAC)
- Polling Facility ID (Auditing mode POLLING_FAC)
- Primary ID (Auditing mode FMS_ID)
The record types that can be audited, the associated keyword, and available auditing modes for each keyword are shown in the following table.
| Record Type | Keyword | Auditing Modes |
|---|---|---|
|
Node Device |
AUDIT_DEVICE |
NODE_ID REPORTING_FAC POLLING_FAC |
|
Node Group |
AUDIT_GROUP |
NODE_ID REPORTING_FAC |
|
Group Entry |
AUDIT_GROUP_ENTRY |
FMS_ID |
|
Group Category |
AUDIT_GROUP_CATEGORY |
FMS_ID |
|
Validation Rules |
AUDIT_VALIDATION_RULE |
FMS_ID |
|
Estimation Rules |
AUDIT_ESTIMATION_RULE |
FMS_ID |
|
System Setting |
AUDIT_SYSTEM_SETTING |
FMS_ID |
|
Unit Set |
AUDIT_UNIT_SET |
FMS_ID |
|
Audit Category |
AUDIT_AUDIT_CAT |
FMS_ID |
|
Normalization Def |
AUDIT_NORMALIZATION_VIEW |
FMS_ID |
|
Data Quality |
AUDIT_DATA_QUALITY |
FMS_ID |
|
Gas Composition Split |
AUDIT_GAS_COMP_SPLIT |
FMS_ID |
See FMS Configuration File Keywords for more information about using keywords.
See the Auditing section for more general information about the CygNet AUD service.
